Share via

az ml workspace private-endpoint

Note

This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml workspace private-endpoint command. Learn more about extensions.

Workspace private endpoint subgroup commands.

Commands

Name Description Type Status
az ml workspace private-endpoint add

Add private endpoint to a workspace.

 Extension GA
az ml workspace private-endpoint delete

Delete the specified private endpoint Connection in the workspace.

 Extension GA
az ml workspace private-endpoint list

List all private endpoints in a workspace.

 Extension GA

az ml workspace private-endpoint add

Add private endpoint to a workspace.

az ml workspace private-endpoint add [--output-metadata-file]
                                     [--path]
                                     [--pe-auto-approval]
                                     [--pe-___location]
                                     [--pe-name]
                                     [--pe-resource-group]
                                     [--pe-subnet-name]
                                     [--pe-subscription-id]
                                     [--pe-vnet-name]
                                     [--resource-group]
                                     [--subscription-id]
                                     [--tags]
                                     [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file ___location for structured object output.

--path

Path to a root directory for run configuration files.

Property Value
Default value: .
--pe-auto-approval

Whether private endpoint connections to the workspace resource via a private link should be auto approved.

Property Value
Default value: False
--pe-___location

Location of the workspace private endpoint. If not specified it will be the same ___location of the workspace.

--pe-name

Name of the workspace private endpoint. Use this parameter to restrict workspace access to private networks, via a private endpoint.

--pe-resource-group

Name of the existing resource group to create the workspace private endpoint in. The vnet should be in the same resource group. If not specified, the resource group of the workspace will be used.

--pe-subnet-name

Name of the existing subnet to create the workspace private endpoint in.

Property Value
Default value: default
--pe-subscription-id

Id of the existing subscription to create the workspace private endpoint in. The vnet should be in the same subscription. If not specified, the subscription Id of the workspace will be used.

--pe-vnet-name

Name of the existing vnet to create the workspace private endpoint in.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--tags

Tags associated with this private endpoint with 'key=value' syntax.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml workspace private-endpoint delete

Delete the specified private endpoint Connection in the workspace.

az ml workspace private-endpoint delete [--output-metadata-file]
                                        [--pe-connection-name]
                                        [--resource-group]
                                        [--subscription-id]
                                        [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file ___location for structured object output.

--pe-connection-name

The name of the Private EndPoint Connection.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml workspace private-endpoint list

List all private endpoints in a workspace.

az ml workspace private-endpoint list [--output-metadata-file]
                                      [--path]
                                      [--resource-group]
                                      [--subscription-id]
                                      [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file ___location for structured object output.

--path

Path to a root directory for run configuration files.

Property Value
Default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False